home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / ssygvd.z / ssygvd
Encoding:
Text File  |  2002-10-03  |  7.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSYYYYGGGGVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSYYYYGGGGVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSYGVD - compute all the eigenvalues, and optionally, the eigenvectors of
  10.      a real generalized symmetric-definite eigenproblem, of the form
  11.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE SSYGVD( ITYPE, JOBZ, UPLO, N, A, LDA, B, LDB, W, WORK, LWORK,
  15.                         IWORK, LIWORK, INFO )
  16.  
  17.          CHARACTER      JOBZ, UPLO
  18.  
  19.          INTEGER        INFO, ITYPE, LDA, LDB, LIWORK, LWORK, N
  20.  
  21.          INTEGER        IWORK( * )
  22.  
  23.          REAL           A( LDA, * ), B( LDB, * ), W( * ), WORK( * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      SSYGVD computes all the eigenvalues, and optionally, the eigenvectors of
  40.      a real generalized symmetric-definite eigenproblem, of the form
  41.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x. Here A and B are
  42.      assumed to be symmetric and B is also positive definite.  If eigenvectors
  43.      are desired, it uses a divide and conquer algorithm.
  44.  
  45.      The divide and conquer algorithm makes very mild assumptions about
  46.      floating point arithmetic. It will work on machines with a guard digit in
  47.      add/subtract, or on those binary machines without guard digits which
  48.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  49.      conceivably fail on hexadecimal or decimal machines without guard digits,
  50.      but we know of none.
  51.  
  52.  
  53. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  54.      ITYPE   (input) INTEGER
  55.              Specifies the problem type to be solved:
  56.              = 1:  A*x = (lambda)*B*x
  57.              = 2:  A*B*x = (lambda)*x
  58.              = 3:  B*A*x = (lambda)*x
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSYYYYGGGGVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSYYYYGGGGVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      JOBZ    (input) CHARACTER*1
  75.              = 'N':  Compute eigenvalues only;
  76.              = 'V':  Compute eigenvalues and eigenvectors.
  77.  
  78.      UPLO    (input) CHARACTER*1
  79.              = 'U':  Upper triangles of A and B are stored;
  80.              = 'L':  Lower triangles of A and B are stored.
  81.  
  82.      N       (input) INTEGER
  83.              The order of the matrices A and B.  N >= 0.
  84.  
  85.      A       (input/output) REAL array, dimension (LDA, N)
  86.              On entry, the symmetric matrix A.  If UPLO = 'U', the leading N-
  87.              by-N upper triangular part of A contains the upper triangular
  88.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  89.              triangular part of A contains the lower triangular part of the
  90.              matrix A.
  91.  
  92.              On exit, if JOBZ = 'V', then if INFO = 0, A contains the matrix Z
  93.              of eigenvectors.  The eigenvectors are normalized as follows:  if
  94.              ITYPE = 1 or 2, Z**T*B*Z = I; if ITYPE = 3, Z**T*inv(B)*Z = I.
  95.              If JOBZ = 'N', then on exit the upper triangle (if UPLO='U') or
  96.              the lower triangle (if UPLO='L') of A, including the diagonal, is
  97.              destroyed.
  98.  
  99.      LDA     (input) INTEGER
  100.              The leading dimension of the array A.  LDA >= max(1,N).
  101.  
  102.      B       (input/output) REAL array, dimension (LDB, N)
  103.              On entry, the symmetric matrix B.  If UPLO = 'U', the leading N-
  104.              by-N upper triangular part of B contains the upper triangular
  105.              part of the matrix B.  If UPLO = 'L', the leading N-by-N lower
  106.              triangular part of B contains the lower triangular part of the
  107.              matrix B.
  108.  
  109.              On exit, if INFO <= N, the part of B containing the matrix is
  110.              overwritten by the triangular factor U or L from the Cholesky
  111.              factorization B = U**T*U or B = L*L**T.
  112.  
  113.      LDB     (input) INTEGER
  114.              The leading dimension of the array B.  LDB >= max(1,N).
  115.  
  116.      W       (output) REAL array, dimension (N)
  117.              If INFO = 0, the eigenvalues in ascending order.
  118.  
  119.      WORK    (workspace/output) REAL array, dimension (LWORK)
  120.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  121.  
  122.      LWORK   (input) INTEGER
  123.              The dimension of the array WORK.  If N <= 1,               LWORK
  124.              >= 1.  If JOBZ = 'N' and N > 1, LWORK >= 2*N+1.  If JOBZ = 'V'
  125.              and N > 1, LWORK >= 1 + 6*N + 2*N**2.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSYYYYGGGGVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSYYYYGGGGVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              If LWORK = -1, then a workspace query is assumed; the routine
  141.              only calculates the optimal size of the WORK array, returns this
  142.              value as the first entry of the WORK array, and no error message
  143.              related to LWORK is issued by XERBLA.
  144.  
  145.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  146.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  147.  
  148.      LIWORK  (input) INTEGER
  149.              The dimension of the array IWORK.  If N <= 1,
  150.              LIWORK >= 1.  If JOBZ  = 'N' and N > 1, LIWORK >= 1.  If JOBZ  =
  151.              'V' and N > 1, LIWORK >= 3 + 5*N.
  152.  
  153.              If LIWORK = -1, then a workspace query is assumed; the routine
  154.              only calculates the optimal size of the IWORK array, returns this
  155.              value as the first entry of the IWORK array, and no error message
  156.              related to LIWORK is issued by XERBLA.
  157.  
  158.      INFO    (output) INTEGER
  159.              = 0:  successful exit
  160.              < 0:  if INFO = -i, the i-th argument had an illegal value
  161.              > 0:  SPOTRF or SSYEVD returned an error code:
  162.              <= N:  if INFO = i, SSYEVD failed to converge; i off-diagonal
  163.              elements of an intermediate tridiagonal form did not converge to
  164.              zero; > N:   if INFO = N + i, for 1 <= i <= N, then the leading
  165.              minor of order i of B is not positive definite.  The
  166.              factorization of B could not be completed and no eigenvalues or
  167.              eigenvectors were computed.
  168.  
  169. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  170.      Based on contributions by
  171.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  172.  
  173.  
  174. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  175.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  176.  
  177.      This man page is available only online.
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.